Update formatting for includes/specialpage
authorSiebrand Mazeland <siebrand@kitano.nl>
Sat, 22 Mar 2014 22:07:19 +0000 (23:07 +0100)
committerSiebrand Mazeland <siebrand@kitano.nl>
Wed, 26 Mar 2014 16:19:41 +0000 (17:19 +0100)
Change-Id: I6f5ebe5408464cde78fae3584e19392b26d2b2a1

includes/specialpage/ChangesListSpecialPage.php
includes/specialpage/RedirectSpecialPage.php
includes/specialpage/SpecialPage.php
includes/specialpage/SpecialPageFactory.php

index 888829a..14ac401 100644 (file)
@@ -80,6 +80,7 @@ abstract class ChangesListSpecialPage extends SpecialPage {
        public function getRows() {
                $opts = $this->getOptions();
                $conds = $this->buildMainQueryConds( $opts );
+
                return $this->doMainQuery( $conds, $opts );
        }
 
@@ -164,6 +165,7 @@ abstract class ChangesListSpecialPage extends SpecialPage {
         */
        protected function fetchOptionsFromRequest( $opts ) {
                $opts->fetchValuesFromRequest( $this->getRequest() );
+
                return $opts;
        }
 
@@ -293,6 +295,7 @@ abstract class ChangesListSpecialPage extends SpecialPage {
                // }
 
                $dbr = $this->getDB();
+
                return $dbr->select(
                        $tables,
                        $fields,
index eb8557a..ee338d4 100644 (file)
@@ -27,7 +27,6 @@
  * @ingroup SpecialPage
  */
 abstract class RedirectSpecialPage extends UnlistedSpecialPage {
-
        // Query parameters that can be passed through redirects
        protected $mAllowedRedirectParams = array();
 
@@ -41,11 +40,13 @@ abstract class RedirectSpecialPage extends UnlistedSpecialPage {
                if ( $redirect instanceof Title ) {
                        $url = $redirect->getFullURL( $query );
                        $this->getOutput()->redirect( $url );
+
                        return $redirect;
                } elseif ( $redirect === true ) {
                        // Redirect to index.php with query parameters
                        $url = wfAppendQuery( wfScript( 'index' ), $query );
                        $this->getOutput()->redirect( $url );
+
                        return $redirect;
                } else {
                        $class = get_class( $this );
@@ -171,12 +172,12 @@ abstract class SpecialRedirectToSpecial extends RedirectSpecialPage {
  *
  * @par Hook extension example:
  * @code
- *     $wgHooks['RedirectSpecialArticleRedirectParams'][] =
- *             'MyExtensionHooks::onRedirectSpecialArticleRedirectParams';
- *     public static function onRedirectSpecialArticleRedirectParams( &$redirectParams ) {
- *             $redirectParams[] = 'stable';
- *             return true;
- *     }
+ *    $wgHooks['RedirectSpecialArticleRedirectParams'][] =
+ *        'MyExtensionHooks::onRedirectSpecialArticleRedirectParams';
+ *    public static function onRedirectSpecialArticleRedirectParams( &$redirectParams ) {
+ *        $redirectParams[] = 'stable';
+ *        return true;
+ *    }
  * @endcode
  *
  * @ingroup SpecialPage
index e824a61..d9340b4 100644 (file)
@@ -74,6 +74,7 @@ class SpecialPage {
         */
        public static function getTitleFor( $name, $subpage = false, $fragment = '' ) {
                $name = SpecialPageFactory::getLocalNameFor( $name, $subpage );
+
                return Title::makeTitle( NS_SPECIAL, $name, $fragment );
        }
 
@@ -157,6 +158,7 @@ class SpecialPage {
         */
        function getFile() {
                wfDeprecated( __METHOD__, '1.18' );
+
                return $this->mFile;
        }
 
@@ -215,6 +217,7 @@ class SpecialPage {
                if ( !isset( $this->mLocalName ) ) {
                        $this->mLocalName = SpecialPageFactory::getLocalNameFor( $this->mName );
                }
+
                return $this->mLocalName;
        }
 
@@ -450,7 +453,6 @@ class SpecialPage {
                        $this->getOutput()->wrapWikiMsg(
                                "<div class='mw-specialpage-summary'>\n$1\n</div>", $msg );
                }
-
        }
 
        /**
@@ -475,6 +477,7 @@ class SpecialPage {
         */
        function getTitle( $subpage = false ) {
                wfDeprecated( __METHOD__, '1.23' );
+
                return $this->getPageTitle( $subpage );
        }
 
@@ -511,6 +514,7 @@ class SpecialPage {
                } else {
                        wfDebug( __METHOD__ . " called and \$mContext is null. " .
                                "Return RequestContext::getMain(); for sanity\n" );
+
                        return RequestContext::getMain();
                }
        }
@@ -564,6 +568,7 @@ class SpecialPage {
         */
        public function getLang() {
                wfDeprecated( __METHOD__, '1.19' );
+
                return $this->getLanguage();
        }
 
@@ -616,6 +621,7 @@ class SpecialPage {
                if ( $this->including() ) {
                        $message->setInterfaceMessageFlag( false );
                }
+
                return $message;
        }
 
index c4b840a..54d9793 100644 (file)
@@ -49,126 +49,126 @@ class SpecialPageFactory {
         */
        private static $list = array(
                // Maintenance Reports
-               'BrokenRedirects'           => 'BrokenRedirectsPage',
-               'Deadendpages'              => 'DeadendPagesPage',
-               'DoubleRedirects'           => 'DoubleRedirectsPage',
-               'Longpages'                 => 'LongPagesPage',
-               'Ancientpages'              => 'AncientPagesPage',
-               'Lonelypages'               => 'LonelyPagesPage',
-               'Fewestrevisions'           => 'FewestrevisionsPage',
-               'Withoutinterwiki'          => 'WithoutInterwikiPage',
-               'Protectedpages'            => 'SpecialProtectedpages',
-               'Protectedtitles'           => 'SpecialProtectedtitles',
-               'Shortpages'                => 'ShortpagesPage',
-               'Uncategorizedcategories'   => 'UncategorizedCategoriesPage',
-               'Uncategorizedimages'       => 'UncategorizedImagesPage',
-               'Uncategorizedpages'        => 'UncategorizedPagesPage',
-               'Uncategorizedtemplates'    => 'UncategorizedTemplatesPage',
-               'Unusedcategories'          => 'UnusedCategoriesPage',
-               'Unusedimages'              => 'UnusedimagesPage',
-               'Unusedtemplates'           => 'UnusedtemplatesPage',
-               'Unwatchedpages'            => 'UnwatchedpagesPage',
-               'Wantedcategories'          => 'WantedCategoriesPage',
-               'Wantedfiles'               => 'WantedFilesPage',
-               'Wantedpages'               => 'WantedPagesPage',
-               'Wantedtemplates'           => 'WantedTemplatesPage',
+               'BrokenRedirects' => 'BrokenRedirectsPage',
+               'Deadendpages' => 'DeadendPagesPage',
+               'DoubleRedirects' => 'DoubleRedirectsPage',
+               'Longpages' => 'LongPagesPage',
+               'Ancientpages' => 'AncientPagesPage',
+               'Lonelypages' => 'LonelyPagesPage',
+               'Fewestrevisions' => 'FewestrevisionsPage',
+               'Withoutinterwiki' => 'WithoutInterwikiPage',
+               'Protectedpages' => 'SpecialProtectedpages',
+               'Protectedtitles' => 'SpecialProtectedtitles',
+               'Shortpages' => 'ShortpagesPage',
+               'Uncategorizedcategories' => 'UncategorizedCategoriesPage',
+               'Uncategorizedimages' => 'UncategorizedImagesPage',
+               'Uncategorizedpages' => 'UncategorizedPagesPage',
+               'Uncategorizedtemplates' => 'UncategorizedTemplatesPage',
+               'Unusedcategories' => 'UnusedCategoriesPage',
+               'Unusedimages' => 'UnusedimagesPage',
+               'Unusedtemplates' => 'UnusedtemplatesPage',
+               'Unwatchedpages' => 'UnwatchedpagesPage',
+               'Wantedcategories' => 'WantedCategoriesPage',
+               'Wantedfiles' => 'WantedFilesPage',
+               'Wantedpages' => 'WantedPagesPage',
+               'Wantedtemplates' => 'WantedTemplatesPage',
 
                // List of pages
-               'Allpages'                  => 'SpecialAllpages',
-               'Prefixindex'               => 'SpecialPrefixindex',
-               'Categories'                => 'SpecialCategories',
-               'Listredirects'             => 'ListredirectsPage',
-               'PagesWithProp'             => 'SpecialPagesWithProp',
+               'Allpages' => 'SpecialAllpages',
+               'Prefixindex' => 'SpecialPrefixindex',
+               'Categories' => 'SpecialCategories',
+               'Listredirects' => 'ListredirectsPage',
+               'PagesWithProp' => 'SpecialPagesWithProp',
 
                // Login/create account
-               'Userlogin'                 => 'LoginForm',
-               'CreateAccount'             => 'SpecialCreateAccount',
+               'Userlogin' => 'LoginForm',
+               'CreateAccount' => 'SpecialCreateAccount',
 
                // Users and rights
-               'Block'                     => 'SpecialBlock',
-               'Unblock'                   => 'SpecialUnblock',
-               'BlockList'                 => 'SpecialBlockList',
-               'ChangePassword'            => 'SpecialChangePassword',
-               'PasswordReset'             => 'SpecialPasswordReset',
-               'DeletedContributions'      => 'DeletedContributionsPage',
-               'Preferences'               => 'SpecialPreferences',
-               'ResetTokens'               => 'SpecialResetTokens',
-               'Contributions'             => 'SpecialContributions',
-               'Listgrouprights'           => 'SpecialListGroupRights',
-               'Listusers'                 => 'SpecialListUsers',
-               'Listadmins'                => 'SpecialListAdmins',
-               'Listbots'                  => 'SpecialListBots',
-               'Userrights'                => 'UserrightsPage',
-               'EditWatchlist'             => 'SpecialEditWatchlist',
+               'Block' => 'SpecialBlock',
+               'Unblock' => 'SpecialUnblock',
+               'BlockList' => 'SpecialBlockList',
+               'ChangePassword' => 'SpecialChangePassword',
+               'PasswordReset' => 'SpecialPasswordReset',
+               'DeletedContributions' => 'DeletedContributionsPage',
+               'Preferences' => 'SpecialPreferences',
+               'ResetTokens' => 'SpecialResetTokens',
+               'Contributions' => 'SpecialContributions',
+               'Listgrouprights' => 'SpecialListGroupRights',
+               'Listusers' => 'SpecialListUsers',
+               'Listadmins' => 'SpecialListAdmins',
+               'Listbots' => 'SpecialListBots',
+               'Userrights' => 'UserrightsPage',
+               'EditWatchlist' => 'SpecialEditWatchlist',
 
                // Recent changes and logs
-               'Newimages'                 => 'SpecialNewFiles',
-               'Log'                       => 'SpecialLog',
-               'Watchlist'                 => 'SpecialWatchlist',
-               'Newpages'                  => 'SpecialNewpages',
-               'Recentchanges'             => 'SpecialRecentChanges',
-               'Recentchangeslinked'       => 'SpecialRecentChangesLinked',
-               'Tags'                      => 'SpecialTags',
+               'Newimages' => 'SpecialNewFiles',
+               'Log' => 'SpecialLog',
+               'Watchlist' => 'SpecialWatchlist',
+               'Newpages' => 'SpecialNewpages',
+               'Recentchanges' => 'SpecialRecentChanges',
+               'Recentchangeslinked' => 'SpecialRecentChangesLinked',
+               'Tags' => 'SpecialTags',
 
                // Media reports and uploads
-               'Listfiles'                 => 'SpecialListFiles',
-               'Filepath'                  => 'SpecialFilepath',
-               'MIMEsearch'                => 'MIMEsearchPage',
-               'FileDuplicateSearch'       => 'FileDuplicateSearchPage',
-               'Upload'                    => 'SpecialUpload',
-               'UploadStash'               => 'SpecialUploadStash',
-               'ListDuplicatedFiles'       => 'ListDuplicatedFilesPage',
+               'Listfiles' => 'SpecialListFiles',
+               'Filepath' => 'SpecialFilepath',
+               'MIMEsearch' => 'MIMEsearchPage',
+               'FileDuplicateSearch' => 'FileDuplicateSearchPage',
+               'Upload' => 'SpecialUpload',
+               'UploadStash' => 'SpecialUploadStash',
+               'ListDuplicatedFiles' => 'ListDuplicatedFilesPage',
 
                // Data and tools
-               'Statistics'                => 'SpecialStatistics',
-               'Allmessages'               => 'SpecialAllmessages',
-               'Version'                   => 'SpecialVersion',
-               'Lockdb'                    => 'SpecialLockdb',
-               'Unlockdb'                  => 'SpecialUnlockdb',
+               'Statistics' => 'SpecialStatistics',
+               'Allmessages' => 'SpecialAllmessages',
+               'Version' => 'SpecialVersion',
+               'Lockdb' => 'SpecialLockdb',
+               'Unlockdb' => 'SpecialUnlockdb',
 
                // Redirecting special pages
-               'LinkSearch'                => 'LinkSearchPage',
-               'Randompage'                => 'RandomPage',
-               'RandomInCategory'          => 'SpecialRandomInCategory',
-               'Randomredirect'            => 'SpecialRandomredirect',
+               'LinkSearch' => 'LinkSearchPage',
+               'Randompage' => 'RandomPage',
+               'RandomInCategory' => 'SpecialRandomInCategory',
+               'Randomredirect' => 'SpecialRandomredirect',
 
                // High use pages
-               'Mostlinkedcategories'      => 'MostlinkedCategoriesPage',
-               'Mostimages'                => 'MostimagesPage',
-               'Mostinterwikis'            => 'MostinterwikisPage',
-               'Mostlinked'                => 'MostlinkedPage',
-               'Mostlinkedtemplates'       => 'MostlinkedTemplatesPage',
-               'Mostcategories'            => 'MostcategoriesPage',
-               'Mostrevisions'             => 'MostrevisionsPage',
+               'Mostlinkedcategories' => 'MostlinkedCategoriesPage',
+               'Mostimages' => 'MostimagesPage',
+               'Mostinterwikis' => 'MostinterwikisPage',
+               'Mostlinked' => 'MostlinkedPage',
+               'Mostlinkedtemplates' => 'MostlinkedTemplatesPage',
+               'Mostcategories' => 'MostcategoriesPage',
+               'Mostrevisions' => 'MostrevisionsPage',
 
                // Page tools
-               'ComparePages'              => 'SpecialComparePages',
-               'Export'                    => 'SpecialExport',
-               'Import'                    => 'SpecialImport',
-               'Undelete'                  => 'SpecialUndelete',
-               'Whatlinkshere'             => 'SpecialWhatLinksHere',
-               'MergeHistory'              => 'SpecialMergeHistory',
-               'ExpandTemplates'           => 'SpecialExpandTemplates',
+               'ComparePages' => 'SpecialComparePages',
+               'Export' => 'SpecialExport',
+               'Import' => 'SpecialImport',
+               'Undelete' => 'SpecialUndelete',
+               'Whatlinkshere' => 'SpecialWhatLinksHere',
+               'MergeHistory' => 'SpecialMergeHistory',
+               'ExpandTemplates' => 'SpecialExpandTemplates',
 
                // Other
-               'Booksources'               => 'SpecialBookSources',
+               'Booksources' => 'SpecialBookSources',
 
                // Unlisted / redirects
-               'Blankpage'                 => 'SpecialBlankpage',
-               'Diff'                      => 'SpecialDiff',
-               'Emailuser'                 => 'SpecialEmailUser',
-               'Movepage'                  => 'MovePageForm',
-               'Mycontributions'           => 'SpecialMycontributions',
-               'Mypage'                    => 'SpecialMypage',
-               'Mytalk'                    => 'SpecialMytalk',
-               'Myuploads'                 => 'SpecialMyuploads',
-               'AllMyUploads'              => 'SpecialAllMyUploads',
-               'PermanentLink'             => 'SpecialPermanentLink',
-               'Redirect'                  => 'SpecialRedirect',
-               'Revisiondelete'            => 'SpecialRevisionDelete',
-               'RunJobs'                   => 'SpecialRunJobs',
-               'Specialpages'              => 'SpecialSpecialpages',
-               'Userlogout'                => 'SpecialUserlogout',
+               'Blankpage' => 'SpecialBlankpage',
+               'Diff' => 'SpecialDiff',
+               'Emailuser' => 'SpecialEmailUser',
+               'Movepage' => 'MovePageForm',
+               'Mycontributions' => 'SpecialMycontributions',
+               'Mypage' => 'SpecialMypage',
+               'Mytalk' => 'SpecialMytalk',
+               'Myuploads' => 'SpecialMyuploads',
+               'AllMyUploads' => 'SpecialAllMyUploads',
+               'PermanentLink' => 'SpecialPermanentLink',
+               'Redirect' => 'SpecialRedirect',
+               'Revisiondelete' => 'SpecialRevisionDelete',
+               'RunJobs' => 'SpecialRunJobs',
+               'Specialpages' => 'SpecialSpecialpages',
+               'Userlogout' => 'SpecialUserlogout',
        );
 
        private static $aliases;
@@ -221,6 +221,7 @@ class SpecialPageFactory {
 
                        wfProfileOut( __METHOD__ );
                }
+
                return self::$list;
        }
 
@@ -254,6 +255,7 @@ class SpecialPageFactory {
                        // Cast to object: func()[$key] doesn't work, but func()->$key does
                        self::$aliases = (object)self::$aliases;
                }
+
                return self::$aliases;
        }
 
@@ -322,6 +324,7 @@ class SpecialPageFactory {
         */
        public static function exists( $name ) {
                list( $title, /*...*/ ) = self::resolveAlias( $name );
+
                return property_exists( self::getList(), $title );
        }
 
@@ -337,6 +340,7 @@ class SpecialPageFactory {
                        $rec = self::getList()->$realName;
                        if ( is_string( $rec ) ) {
                                $className = $rec;
+
                                return new $className;
                        } elseif ( is_array( $rec ) ) {
                                // @deprecated, officially since 1.18, unofficially since forever
@@ -344,6 +348,7 @@ class SpecialPageFactory {
                                $className = array_shift( $rec );
                                self::getList()->$realName = MWFunction::newObj( $className, $rec );
                        }
+
                        return self::getList()->$realName;
                } else {
                        return null;
@@ -375,6 +380,7 @@ class SpecialPageFactory {
                                }
                        }
                }
+
                return $pages;
        }
 
@@ -391,6 +397,7 @@ class SpecialPageFactory {
                                $pages[$name] = $page;
                        }
                }
+
                return $pages;
        }
 
@@ -413,6 +420,7 @@ class SpecialPageFactory {
                                $pages[$name] = $page;
                        }
                }
+
                return $pages;
        }
 
@@ -454,6 +462,7 @@ class SpecialPageFactory {
 
                        $context->getOutput()->showErrorPage( 'nosuchspecialpage', 'nospecialpagetext' );
                        wfProfileOut( __METHOD__ );
+
                        return false;
                }
 
@@ -473,13 +482,14 @@ class SpecialPageFactory {
                                $url = $title->getFullURL( $query );
                                $context->getOutput()->redirect( $url );
                                wfProfileOut( __METHOD__ );
+
                                return $title;
                        } else {
                                $context->setTitle( $page->getPageTitle( $par ) );
                        }
-
                } elseif ( !$page->isIncludable() ) {
                        wfProfileOut( __METHOD__ );
+
                        return false;
                }
 
@@ -491,6 +501,7 @@ class SpecialPageFactory {
                $page->run( $par );
                wfProfileOut( $profName );
                wfProfileOut( __METHOD__ );
+
                return true;
        }
 
@@ -571,6 +582,7 @@ class SpecialPageFactory {
                if ( $subpage !== false && !is_null( $subpage ) ) {
                        $name = "$name/$subpage";
                }
+
                return $wgContLang->ucfirst( $name );
        }